👌 IMPROVE: Master doc title specified in _toc.yml is visible in left-sidebar
#304
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chrisjsewell
reviewed
Apr 8, 2021
| # check title in globaltoc (jb case) else get title from doctree | ||
| master_title = None | ||
| with suppress(Exception): | ||
| master_title = app.config["globaltoc"].get("title") |
There was a problem hiding this comment.
note this won't work quite the same with jupyter-book/jupyter-book#1293. But I would be interested if there is a less theme specific solution that could go straight into sphinx-external-toc 🤔
There was a problem hiding this comment.
@chrisjsewell you mean creating a global variable in sphinx-external-toc which has this value? and can be accessed directly in any theme.
|
It seems like this one is a bit stale - and maybe addressed at the sphinx-external-toc level? I'll close it so that we have less cruft to worry about in a refactor, but we can re-visit if this issue still persists |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As outlined in this issue jupyter-book/jupyter-book#1012 , master_doc title specified with
titlekey in_toc.ymlwas not reflecting in the left sidebar. This PR fixes that.Example:
results in:-
@choldgraf, the test infrastructure in this repo uses sphinx-build as it is
jbagnostic. So, I won't be able to test this feature( which is directed only towards jb projects) here right?fixes jupyter-book/jupyter-book#1012